package com.rimi.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 *
 */

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     *  将一个Docket对象交给spring管理
     * @return
     */
    @Bean
    public Docket api() {
//          指明 当前文档类型为swagger2
        return new Docket(DocumentationType.SWAGGER_2)
//                初始化
                .select()
                /***
                 重要的两个方法:
                 apis():指定要生成文档的接口包基本路径，，以接口为路径，填写包名
                 paths():指定针对哪些URL请求生成接口文档
                        .paths(PathSelectors.any())  对所有符合要求的url生成文档

                 ****/

                .apis(RequestHandlerSelectors.basePackage("com.rimi.controller"))
                .paths(PathSelectors.any())
                .build()

//                接口文档头部说明
                .apiInfo(apiInfo());
    }

    /**
     *  构建头部信息的说明
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
//                文档标题
                .title("MSG系统接口文档")
//                描述
                .description("服务于MSG内部系统")
//                版本号
                .version("1.0.0")
//                项目跳转地址
                .termsOfServiceUrl("")
                .build();
    }
}
